home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / COLORSAY.HDR < prev    next >
Text File  |  1994-04-25  |  2KB  |  51 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _ColorSay(nRow, nCol, cString) --> NIL
  8.  
  9. PARAMETERS:
  10.  
  11. nRow    : Row to print string    (DEFAULT: row())
  12. nCol    : Colomn to print string (DEFAULT: col())
  13. cString : The string to print
  14.  
  15. SHORT:
  16.  
  17. Write text on screen matching colors already on screen at that position(s).
  18.  
  19. DESCRIPTION:
  20.  
  21. _ColorSay() prints cString on the screen, beginning at nRow, nCol and
  22. extending for the length of cString.
  23.  
  24. Each byte of the string is written in the current color of the row/col of the
  25. screen where it falls.
  26.  
  27. Thus, if the screen colors change as the string is written, cString changes
  28. colors with it!
  29.  
  30. It is useful for user interface design where you cannot know what color might
  31. be at a given set of coordinates, but you want to write something there and
  32. color match it regardless.
  33.  
  34. _ColorSay() always returns NIL.
  35.  
  36. NOTE:
  37.  
  38. This function is the opposite of _ReColor(), which changes the color of
  39. a screen area leaving the text there.  In this respect it is similar
  40. to _HiLight().
  41.  
  42. EXAMPLE:
  43.  
  44. _ColorSay(5,10,"BATTLESTAR GALACTICA")
  45.  
  46. Result: "BATTLESTAR GALACTICA" is written on the screen at 5,10, and each
  47. byte is set to the color that was already on the screen where the byte
  48. was written.
  49.  
  50. ******************************************************************************/
  51.